<?php
return [
	// 文档标题
	'title' => 'API接口文档',
	// 文档描述
	'desc' => 'API接口文档',
	// 默认请求类型
	'default_method' => 'GET',
	// 允许跨域访问
	'allowCrossDomain' => false,
	// 设置可选版本
	'apps' => [
		[
			'title' => '接口管理',
			'path' => 'app\api\controller',
			'key' => 'api',

			'groups' => [
				['title' => '接口', 'name' => 'index'],
			],
			'controllers' => [
				'AddressController',
				'AuthController',
				'ArticleController',
				'CartController',
				'CityController',
				'GoodsCateController',
				'GoodsController',
				'GoodsItemController',
				'IndexController',
				'MegaphoneController',
				'MessageController',
				'NotificationController',
				'OrderController',
				'OrderGoodsController',
				'RegionController',
				'ShopCateController',
				'ShopCollectController',
				'ShopController',
				'UserCollectController',
				'UserController',
				'UserTradeController',
			],

		],

	],
	// 自动生成url规则
	'auto_url' => [
		// 字母规则
		'letter_rule' => "lcfirst",
		// 多级路由分隔符
		'multistage_route_separator' => ".",
	],
	// 指定公共注释定义的文件地址
	'definitions' => "app\common\controller\Definitions",
	// 缓存配置
	'cache' => [
		// 是否开启缓存
		'enable' => false,
	],
	// 权限认证配置
	'auth' => [
		// 是否启用密码验证
		'enable' => false,
		// 全局访问密码
		'password' => "123456",
		// 密码加密盐
		'secret_key' => "apidoc#hg_code",
		// 有效期
		'expire' => 24 * 60 * 60,
	],
	// 统一的请求Header
	'params' => [
		// （选配）全局的请求Header
		'header' => [
			// name=字段名，type=字段类型，require=是否必须，default=默认值，desc=字段描述
			['name' => 'token', 'type' => 'string', 'require' => true, 'desc' => '身份令牌Token'],
		],
		// （选配）全局的请求Query
		'query' => [
			// 同上 header
		],
		// （选配）全局的请求Body
		'body' => [
			// 同上 header
		],
	],
	// 统一的请求参数Parameters
	'parameters' => [],
	// 统一的请求响应体
	'responses' => [
		['name' => 'code', 'desc' => '代码', 'type' => 'int'],
		['name' => 'msg', 'desc' => '业务信息', 'type' => 'string'],
		['name' => 'data', 'desc' => '业务数据', 'main' => true, 'type' => 'object'],
	],
	// md文档
	'docs' => [],

];
